<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class LoggerCategory</title>
			<link rel="stylesheet" href="../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Class LoggerCategory</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
															<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">This class has been deprecated and replaced by the Logger subclass.</p>
	<ul class="tags">
				<li><span class="field">author:</span> VxR &lt;<a href="mailto:vxr@vxr.it">vxr@vxr.it</a>&gt;</li>
				<li><span class="field">version:</span> $Revision: 1.17 $</li>
				<li><span class="field">see:</span> Logger</li>
			</ul>
		<p class="notes">
			Located in <a class="field" href="_log---LoggerCategory.php.html">/log/LoggerCategory.php</a> (line <span class="field">16</span>)
		</p>
		
				
		<pre></pre>
	
			</div>
</div>




	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
												<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
																																																																																																																																				
												<div class="method-definition">
											<span class="method-result">LoggerCategory</span>
										<a href="#__construct" title="details" class="method-name">__construct</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$file</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#debug" title="details" class="method-name">debug</a>
											(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$message</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$caller</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#err" title="details" class="method-name">err</a>
											(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$message</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$caller</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#error" title="details" class="method-name">error</a>
											(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$message</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$caller</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#fatal" title="details" class="method-name">fatal</a>
											(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$message</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$caller</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#forcedLog" title="details" class="method-name">forcedLog</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$fqcn</span>, <span class="var-type"><a href="../log4php/LoggerLevel.html">LoggerLevel</a></span>&nbsp;<span class="var-name">$level</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$message</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$caller</span>)
									</div>
																<div class="method-definition">
											<span class="method-result"><a href="../log4php/LoggerLevel.html">LoggerLevel</a></span>
										<a href="#getEffectiveLevel" title="details" class="method-name">getEffectiveLevel</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result"><a href="../log4php/LoggerLevel.html">LoggerLevel</a></span>
										<a href="#getLevel" title="details" class="method-name">getLevel</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#getName" title="details" class="method-name">getName</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#info" title="details" class="method-name">info</a>
											(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$message</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$caller</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">boolean</span>
										<a href="#isDebugEnabled" title="details" class="method-name">isDebugEnabled</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">boolean</span>
										<a href="#isEnabledFor" title="details" class="method-name">isEnabledFor</a>
											(<span class="var-type"><a href="../log4php/LoggerLevel.html">LoggerLevel</a></span>&nbsp;<span class="var-name">$level</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">boolean</span>
										<a href="#isInfoEnabled" title="details" class="method-name">isInfoEnabled</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#setLevel" title="details" class="method-name">setLevel</a>
											(<span class="var-type"><a href="../log4php/LoggerLevel.html">LoggerLevel</a></span>&nbsp;<span class="var-name">$level</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#setName" title="details" class="method-name">setName</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$name</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#warn" title="details" class="method-name">warn</a>
											(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$message</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$caller</span>)
									</div>
								</div>
		</div>
	</div>		

	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
																<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>

<a name="method__construct" id="__construct"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">Constructor __construct</span> (line <span class="line-number">35</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Constructor.</p>
	
	<div class="method-signature">
		<span class="method-result">LoggerCategory</span>
		<span class="method-name">
			__construct
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$file</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$name</span><span class="var-description">: Category name</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">$file</span>			</li>
				</ul>
		
			
	</div>
<a name="methoddebug" id="debug"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">debug</span> (line <span class="line-number">47</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Log a message object with the DEBUG level including the caller.</p>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			debug
		</span>
					(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$message</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$caller</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">mixed</span>
				<span class="var-name">$message</span><span class="var-description">: message</span>			</li>
					<li>
				<span class="var-type">mixed</span>
				<span class="var-name">$caller</span><span class="var-description">: caller object or caller string id</span>			</li>
				</ul>
		
			
	</div>
<a name="methoderr" id="err"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">err</span> (line <span class="line-number">76</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Log a message object with the ERROR level including the caller.</p>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			err
		</span>
					(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$message</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$caller</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">mixed</span>
				<span class="var-name">$message</span><span class="var-description">: message</span>			</li>
					<li>
				<span class="var-type">mixed</span>
				<span class="var-name">$caller</span><span class="var-description">: caller object or caller string id</span>			</li>
				</ul>
		
			
	</div>
<a name="methoderror" id="error"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">error</span> (line <span class="line-number">61</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Log a message object with the ERROR level including the caller.</p>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			error
		</span>
					(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$message</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$caller</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">mixed</span>
				<span class="var-name">$message</span><span class="var-description">: message</span>			</li>
					<li>
				<span class="var-type">mixed</span>
				<span class="var-name">$caller</span><span class="var-description">: caller object or caller string id</span>			</li>
				</ul>
		
			
	</div>
<a name="methodfatal" id="fatal"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">fatal</span> (line <span class="line-number">90</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Log a message object with the FATAL level including the caller.</p>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			fatal
		</span>
					(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$message</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$caller</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">mixed</span>
				<span class="var-name">$message</span><span class="var-description">: message</span>			</li>
					<li>
				<span class="var-type">mixed</span>
				<span class="var-name">$caller</span><span class="var-description">: caller object or caller string id</span>			</li>
				</ul>
		
			
	</div>
<a name="methodforcedLog" id="forcedLog"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">forcedLog</span> (line <span class="line-number">110</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">This method creates a new logging event and logs the event without further checks.</p>
<p class="description"><p>It should not be called directly. Use <a href="../log4php/LoggerCategory.html#methodinfo">info()</a>, <a href="../log4php/LoggerCategory.html#methoddebug">debug()</a>, <a href="../log4php/LoggerCategory.html#methodwarn">warn()</a>,  <a href="../log4php/LoggerCategory.html#methoderror">error()</a> and <a href="../log4php/LoggerCategory.html#methodfatal">fatal()</a> wrappers.</p></p>
	<ul class="tags">
				<li><span class="field">see:</span> LoggerLoggingEvent</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			forcedLog
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$fqcn</span>, <span class="var-type"><a href="../log4php/LoggerLevel.html">LoggerLevel</a></span>&nbsp;<span class="var-name">$level</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$message</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$caller</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$fqcn</span><span class="var-description">: Fully Qualified Class Name of the Logger</span>			</li>
					<li>
				<span class="var-type">mixed</span>
				<span class="var-name">$caller</span><span class="var-description">: caller object or caller string id</span>			</li>
					<li>
				<span class="var-type"><a href="../log4php/LoggerLevel.html">LoggerLevel</a></span>
				<span class="var-name">$level</span><span class="var-description">: log level</span>			</li>
					<li>
				<span class="var-type">mixed</span>
				<span class="var-name">$message</span><span class="var-description">: message</span>			</li>
				</ul>
		
			
	</div>
<a name="methodgetEffectiveLevel" id="getEffectiveLevel"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getEffectiveLevel</span> (line <span class="line-number">126</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Starting from this category, search the category hierarchy for a non-null level and return it.</p>
	<ul class="tags">
				<li><span class="field">return:</span> or null</li>
				<li><span class="field">see:</span> <a href="../log4php/LoggerLevel.html">LoggerLevel</a></li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result"><a href="../log4php/LoggerLevel.html">LoggerLevel</a></span>
		<span class="method-name">
			getEffectiveLevel
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetLevel" id="getLevel"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getLevel</span> (line <span class="line-number">135</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the assigned Level, if any, for this Category.</p>
	<ul class="tags">
				<li><span class="field">return:</span> or null</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result"><a href="../log4php/LoggerLevel.html">LoggerLevel</a></span>
		<span class="method-name">
			getLevel
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetName" id="getName"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getName</span> (line <span class="line-number">144</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return the category name.</p>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			getName
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodinfo" id="info"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">info</span> (line <span class="line-number">161</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Log a message object with the INFO Level.</p>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			info
		</span>
					(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$message</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$caller</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">mixed</span>
				<span class="var-name">$message</span><span class="var-description">: message</span>			</li>
					<li>
				<span class="var-type">mixed</span>
				<span class="var-name">$caller</span><span class="var-description">: caller object or caller string id</span>			</li>
				</ul>
		
			
	</div>
<a name="methodisDebugEnabled" id="isDebugEnabled"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">isDebugEnabled</span> (line <span class="line-number">174</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Check whether this category is enabled for the DEBUG Level.</p>
	
	<div class="method-signature">
		<span class="method-result">boolean</span>
		<span class="method-name">
			isDebugEnabled
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodisEnabledFor" id="isEnabledFor"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">isEnabledFor</span> (line <span class="line-number">186</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Check whether this category is enabled for a given Level passed as parameter.</p>
	
	<div class="method-signature">
		<span class="method-result">boolean</span>
		<span class="method-name">
			isEnabledFor
		</span>
					(<span class="var-type"><a href="../log4php/LoggerLevel.html">LoggerLevel</a></span>&nbsp;<span class="var-name">$level</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"><a href="../log4php/LoggerLevel.html">LoggerLevel</a></span>
				<span class="var-name">$level</span><span class="var-description">: level</span>			</li>
				</ul>
		
			
	</div>
<a name="methodisInfoEnabled" id="isInfoEnabled"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">isInfoEnabled</span> (line <span class="line-number">196</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Check whether this category is enabled for the info Level.</p>
	<ul class="tags">
				<li><span class="field">see:</span> <a href="../log4php/LoggerLevel.html">LoggerLevel</a></li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">boolean</span>
		<span class="method-name">
			isInfoEnabled
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodsetLevel" id="setLevel"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">setLevel</span> (line <span class="line-number">207</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set the level of this Category.</p>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			setLevel
		</span>
					(<span class="var-type"><a href="../log4php/LoggerLevel.html">LoggerLevel</a></span>&nbsp;<span class="var-name">$level</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"><a href="../log4php/LoggerLevel.html">LoggerLevel</a></span>
				<span class="var-name">$level</span><span class="var-description">: a level string or a level costant</span>			</li>
				</ul>
		
			
	</div>
<a name="methodsetName" id="setName"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">setName</span> (line <span class="line-number">149</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			setName
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$name</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"></span>
				<span class="var-name">$name</span>			</li>
				</ul>
		
			
	</div>
<a name="methodwarn" id="warn"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">warn</span> (line <span class="line-number">218</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Log a message with the WARN level.</p>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			warn
		</span>
					(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$message</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$caller</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">mixed</span>
				<span class="var-name">$message</span><span class="var-description">: message</span>			</li>
					<li>
				<span class="var-type">mixed</span>
				<span class="var-name">$caller</span><span class="var-description">: caller object or caller string id</span>			</li>
				</ul>
		
			
	</div>
						
		</div>
	</div>


	<p class="notes" id="credit">
		Documentation generated on Sat, 09 Feb 2008 11:57:31 +0200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
	</p>
	</div></body>
</html>